Update readme with setup instructions #160
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
magul
requested review from
a team and
Rafalkufel
and removed request for
a team
Rafalkufel
approved these changes
Oct 9, 2025
Contributor
Rafalkufel
left a comment
Rafalkufel
left a comment
There was a problem hiding this comment.
As I said yesterday, it's quite an achievement to set this project up on Mac without docker, and all steps are very useful for people who use Mac. But usually developers, who works on linux uses dockerized version of this app. WDYT to split it into at least two sections: for mac and for linux?
| mkdir -p "$HOME/Documents/Alinka" | ||
|
|
||
| # Run migrations | ||
| poetry run alembic upgrade head |
Contributor
There was a problem hiding this comment.
Migration should run automatically on app startup
| # Run migrations | ||
| poetry run alembic upgrade head | ||
|
|
||
| # Populate database with test data (WARNING: This can take a long time and may hang) |
Contributor
There was a problem hiding this comment.
Verrrry good point. It indeed might be a bit confusing 😃
Rafalkufel
reviewed
Oct 9, 2025
| poetry run alembic revision --autogenerate -m "your_message" | ||
|
|
||
| # Apply migrations | ||
| poetry run alembic upgrade head |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: I use
asdffor local setup, and notpyenv